Replace GTK_NO_CHECK_CASTS by G_DISABLE_CAST_CHECKS.
authorMatthias Clasen <matthiasc@src.gnome.org>
Mon, 7 Jan 2002 00:13:33 +0000 (00:13 +0000)
committerMatthias Clasen <matthiasc@src.gnome.org>
Mon, 7 Jan 2002 00:13:33 +0000 (00:13 +0000)
        * docs/debugging.txt: Replace GTK_NO_CHECK_CASTS by
        G_DISABLE_CAST_CHECKS.

        * gtk/gtkaccelgroup.c (gtk_accel_group_from_accel_closure,
        gtk_accel_group_query, gtk_accel_group_find,
        gtk_accel_groups_from_object): Document.

        * gtk/gtkaccellabel.c (gtk_accel_label_set_accel_closure): Document.

        * gtk/tmpl/gtktypeutils.sgml: Replace GTK_NO_CHECK_CASTS by
        G_DISABLE_CAST_CHECKS, fix some markup and add stuff.

        * gtk/tmpl/gtkaccelgroup.sgml, gtk/tmpl/gtkwidget.sgml: Additions.

        * gtk/gtk-sections.txt: Make gtk_accel_group_get_type private.

15 files changed:
ChangeLog
ChangeLog.pre-2-0
ChangeLog.pre-2-10
ChangeLog.pre-2-2
ChangeLog.pre-2-4
ChangeLog.pre-2-6
ChangeLog.pre-2-8
docs/debugging.txt
docs/reference/ChangeLog
docs/reference/gtk/gtk-sections.txt
docs/reference/gtk/tmpl/gtkaccelgroup.sgml
docs/reference/gtk/tmpl/gtktypeutils.sgml
docs/reference/gtk/tmpl/gtkwidget.sgml
gtk/gtkaccelgroup.c
gtk/gtkaccellabel.c

index 2c9f27ef359c835a4bbc745bb53e320fbe0ad854..63c0f59e042975f6b1bf3608b2b2a020d019723d 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,14 @@
+2002-01-06  Matthias Clasen  <matthiasc@poet.de>
+       * docs/debugging.txt: Replace GTK_NO_CHECK_CASTS by 
+       G_DISABLE_CAST_CHECKS.
+
+       * gtk/gtkaccelgroup.c (gtk_accel_group_from_accel_closure,
+       gtk_accel_group_query, gtk_accel_group_find,
+       gtk_accel_groups_from_object): Document.
+
+       * gtk/gtkaccellabel.c (gtk_accel_label_set_accel_closure): Document.
+
 2002-01-04  Hans Breuer  <hans@breuer.org>
 
        * gdk/gdkdraw.c gdk/gdkpixbuf-drawable.c : 
index 2c9f27ef359c835a4bbc745bb53e320fbe0ad854..63c0f59e042975f6b1bf3608b2b2a020d019723d 100644 (file)
@@ -1,3 +1,14 @@
+2002-01-06  Matthias Clasen  <matthiasc@poet.de>
+       * docs/debugging.txt: Replace GTK_NO_CHECK_CASTS by 
+       G_DISABLE_CAST_CHECKS.
+
+       * gtk/gtkaccelgroup.c (gtk_accel_group_from_accel_closure,
+       gtk_accel_group_query, gtk_accel_group_find,
+       gtk_accel_groups_from_object): Document.
+
+       * gtk/gtkaccellabel.c (gtk_accel_label_set_accel_closure): Document.
+
 2002-01-04  Hans Breuer  <hans@breuer.org>
 
        * gdk/gdkdraw.c gdk/gdkpixbuf-drawable.c : 
index 2c9f27ef359c835a4bbc745bb53e320fbe0ad854..63c0f59e042975f6b1bf3608b2b2a020d019723d 100644 (file)
@@ -1,3 +1,14 @@
+2002-01-06  Matthias Clasen  <matthiasc@poet.de>
+       * docs/debugging.txt: Replace GTK_NO_CHECK_CASTS by 
+       G_DISABLE_CAST_CHECKS.
+
+       * gtk/gtkaccelgroup.c (gtk_accel_group_from_accel_closure,
+       gtk_accel_group_query, gtk_accel_group_find,
+       gtk_accel_groups_from_object): Document.
+
+       * gtk/gtkaccellabel.c (gtk_accel_label_set_accel_closure): Document.
+
 2002-01-04  Hans Breuer  <hans@breuer.org>
 
        * gdk/gdkdraw.c gdk/gdkpixbuf-drawable.c : 
index 2c9f27ef359c835a4bbc745bb53e320fbe0ad854..63c0f59e042975f6b1bf3608b2b2a020d019723d 100644 (file)
@@ -1,3 +1,14 @@
+2002-01-06  Matthias Clasen  <matthiasc@poet.de>
+       * docs/debugging.txt: Replace GTK_NO_CHECK_CASTS by 
+       G_DISABLE_CAST_CHECKS.
+
+       * gtk/gtkaccelgroup.c (gtk_accel_group_from_accel_closure,
+       gtk_accel_group_query, gtk_accel_group_find,
+       gtk_accel_groups_from_object): Document.
+
+       * gtk/gtkaccellabel.c (gtk_accel_label_set_accel_closure): Document.
+
 2002-01-04  Hans Breuer  <hans@breuer.org>
 
        * gdk/gdkdraw.c gdk/gdkpixbuf-drawable.c : 
index 2c9f27ef359c835a4bbc745bb53e320fbe0ad854..63c0f59e042975f6b1bf3608b2b2a020d019723d 100644 (file)
@@ -1,3 +1,14 @@
+2002-01-06  Matthias Clasen  <matthiasc@poet.de>
+       * docs/debugging.txt: Replace GTK_NO_CHECK_CASTS by 
+       G_DISABLE_CAST_CHECKS.
+
+       * gtk/gtkaccelgroup.c (gtk_accel_group_from_accel_closure,
+       gtk_accel_group_query, gtk_accel_group_find,
+       gtk_accel_groups_from_object): Document.
+
+       * gtk/gtkaccellabel.c (gtk_accel_label_set_accel_closure): Document.
+
 2002-01-04  Hans Breuer  <hans@breuer.org>
 
        * gdk/gdkdraw.c gdk/gdkpixbuf-drawable.c : 
index 2c9f27ef359c835a4bbc745bb53e320fbe0ad854..63c0f59e042975f6b1bf3608b2b2a020d019723d 100644 (file)
@@ -1,3 +1,14 @@
+2002-01-06  Matthias Clasen  <matthiasc@poet.de>
+       * docs/debugging.txt: Replace GTK_NO_CHECK_CASTS by 
+       G_DISABLE_CAST_CHECKS.
+
+       * gtk/gtkaccelgroup.c (gtk_accel_group_from_accel_closure,
+       gtk_accel_group_query, gtk_accel_group_find,
+       gtk_accel_groups_from_object): Document.
+
+       * gtk/gtkaccellabel.c (gtk_accel_label_set_accel_closure): Document.
+
 2002-01-04  Hans Breuer  <hans@breuer.org>
 
        * gdk/gdkdraw.c gdk/gdkpixbuf-drawable.c : 
index 2c9f27ef359c835a4bbc745bb53e320fbe0ad854..63c0f59e042975f6b1bf3608b2b2a020d019723d 100644 (file)
@@ -1,3 +1,14 @@
+2002-01-06  Matthias Clasen  <matthiasc@poet.de>
+       * docs/debugging.txt: Replace GTK_NO_CHECK_CASTS by 
+       G_DISABLE_CAST_CHECKS.
+
+       * gtk/gtkaccelgroup.c (gtk_accel_group_from_accel_closure,
+       gtk_accel_group_query, gtk_accel_group_find,
+       gtk_accel_groups_from_object): Document.
+
+       * gtk/gtkaccellabel.c (gtk_accel_label_set_accel_closure): Document.
+
 2002-01-04  Hans Breuer  <hans@breuer.org>
 
        * gdk/gdkdraw.c gdk/gdkpixbuf-drawable.c : 
index 43f8182a5298e8f6390480c49352d9de61b9b336..78fde099b67005294dd91450e2a81e4c5b165502 100644 (file)
@@ -19,7 +19,7 @@ G_DISABLE_ASSERT
 G_DISABLE_CHECKS
   If set, disable the g_return_if_fail and g_return_val_if_fail macros
 
-GTK_NO_CHECK_CASTS
+G_DISABLE_CAST_CHECKS
   If set, don't check casts between different object types
 
 
@@ -28,7 +28,7 @@ time by the --enable-debug option.
 
 --enable-debug=minimum [default]
   Enable only inexpensive sanity checking 
-    sets GTK_NO_CHECK_CASTS
+    sets G_DISABLE_CAST_CHECKS
 
 --enable-debug=yes
   Enable all debugging support
@@ -36,7 +36,7 @@ time by the --enable-debug option.
 
 --enable-debug=no (or --disable-debug)
   Disable all debugging support (fastest)
-    sets G_DISABLE_ASSERT, G_DISABLE_CHECKS, and GTK_NO_CHECK_CASTS
+    sets G_DISABLE_ASSERT, G_DISABLE_CHECKS, and G_DISABLE_CAST_CHECKS
 
 Note that !G_DISABLE_CHECKS and --enable-debug=no are to be considered
 not only fast, but dangerous as they tend to destabilize even mostly
@@ -103,4 +103,4 @@ and the object system.
 
 
                                     - 2001-08-13 Matthias Clasen
-                                    - 98/02/19 Owen Taylor
\ No newline at end of file
+                                    - 98/02/19 Owen Taylor
index 7f36d770d18f320a7ed454144180b1e480a32caf..a58e455b420c54a1818e65646fff8d39f5768d63 100644 (file)
@@ -1,3 +1,12 @@
+2002-01-06  Matthias Clasen  <matthiasc@poet.de>
+
+       * gtk/tmpl/gtktypeutils.sgml: Replace GTK_NO_CHECK_CASTS by 
+       G_DISABLE_CAST_CHECKS, fix some markup and add stuff.
+
+       * gtk/tmpl/gtkaccelgroup.sgml, gtk/tmpl/gtkwidget.sgml: Additions.
+
+       * gtk/gtk-sections.txt: Make gtk_accel_group_get_type private.
+
 2002-01-06  Havoc Pennington  <hp@pobox.com>
 
        * gtk/question_index.sgml: a few more questions I thought of
index 05f32bde4a624d28b9c0c41b0ac0c4d25327cdcc..065df44efdfba421baf9d13a5826bb621e5a6b73 100644 (file)
@@ -5,7 +5,6 @@
 <FILE>gtkaccelgroup</FILE>
 <TITLE>Keyboard Accelerators</TITLE>
 GtkAccelGroup
-gtk_accel_group_get_type
 gtk_accel_group_new
 gtk_accel_group_ref
 gtk_accel_group_unref
@@ -27,8 +26,11 @@ gtk_accelerator_parse
 gtk_accelerator_name
 gtk_accelerator_set_default_mod_mask
 gtk_accelerator_get_default_mod_mask
+
 <SUBSECTION Private>
 GtkAccelGroupEntry
+gtk_accel_group_get_type
+
 <SUBSECTION Standard>
 GtkAccelGroupClass
 GTK_TYPE_ACCEL_GROUP
index 46ea598e36106982d9c0af10eb69189f001d08d6..acacceda040819377d976cb87d460d709dcb6c24 100644 (file)
@@ -56,22 +56,17 @@ An object representing and maintaining a group of accelerators.
 
 <!-- ##### MACRO gtk_accel_group_ref ##### -->
 <para>
-
+Deprecated equivalent of g_object_ref().
 </para>
 
 @Returns: 
-<!-- # Unused Parameters # -->
-@accel_group: 
 
 
 <!-- ##### MACRO gtk_accel_group_unref ##### -->
 <para>
-
+Deprecated equivalent of g_object_unref().
 </para>
 
-<!-- # Unused Parameters # -->
-@accel_group: 
-
 
 <!-- ##### FUNCTION gtk_accel_group_connect ##### -->
 <para>
index 59c2bd6b3a9a88b25ccd5b9f7ae40739aaf04901..7008b5006cd183607708fced2bbaccba0e7b740f 100644 (file)
@@ -6,7 +6,7 @@ Handle run-time type creation.
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
-Gtk's type system is extensible.  Because of that, types have to be
+The GTK+ type system is extensible.  Because of that, types have to be
 managed at runtime.
 </para>
 
@@ -17,7 +17,7 @@ managed at runtime.
 
 <!-- ##### TYPEDEF GtkType ##### -->
 <para>
-@GtkType is unique integer identifying the type.  The guts of the
+#GtkType is unique integer identifying the type.  The guts of the
 information about the type is held in a private struct named
 #GtkTypeNode.
 </para>
@@ -97,27 +97,27 @@ Use in place of <function>offsetof()</function>, which is used if it exists.
 
 <!-- ##### MACRO GTK_CHECK_CAST ##### -->
 <para>
-Casts the object in @tobj into @cast.  If GTK_NO_CHECK_CASTS is
+Casts the object in @tobj into @cast.  If %G_DISABLE_CAST_CHECKS is
 defined, just cast it.  Otherwise, check to see if we can cast @tobj
 into a @cast.
 </para>
 
 <!-- # Unused Parameters # -->
-@tobj: a pointer to a GtkObject.
-@cast_type: a Gtk type.
+@tobj: a #GtkObject.
+@cast_type: a GTK+ type.
 @cast: a C type
 
 
 <!-- ##### MACRO GTK_CHECK_CLASS_CAST ##### -->
 <para>
-Casts the object in @tobj into @cast.  If GTK_NO_CHECK_CASTS is
+Casts the object in @tobj into @cast.  If %G_DISABLE_CAST_CHECKS is
 defined, just cast it.  Otherwise, check to see if we can cast @tobj
 into a @cast.
 </para>
 
 <!-- # Unused Parameters # -->
-@tclass: a pointer to a GtkClassInitFunc
-@cast_type: a Gtk type.
+@tclass: a #GtkClassInitFunc
+@cast_type: a GTK+ type.
 @cast: a C type
 
 
@@ -127,7 +127,7 @@ Determines whether @type_object is a type of @otype.
 </para>
 
 <!-- # Unused Parameters # -->
-@type_object: A GtkTypeObject object.
+@type_object: a #GtkTypeObject object
 @otype: 
 
 
@@ -137,20 +137,21 @@ Determines whether @type_class is a type of @otype.
 </para>
 
 <!-- # Unused Parameters # -->
-@type_class: GtkTypeClass class.
+@type_class: a #GtkTypeClass class.
 @otype: 
 
 
 <!-- ##### MACRO GTK_CHECK_GET_CLASS ##### -->
 <para>
-
+Gets the class of @tobj.
 </para>
 
+@tobj: a #GtkObject.
 
 
 <!-- ##### MACRO GTK_FUNDAMENTAL_TYPE ##### -->
 <para>
-Converts a Gtk type into a fundamental type.
+Converts a GTK+ type into a fundamental type.
 </para>
 
 <!-- # Unused Parameters # -->
@@ -189,8 +190,8 @@ Defines a function pointer.
 Defines a function pointer.
 </para>
 
-@data: gpointer
-@Returns: gint
+@data: #gpointer
+@Returns: #gint
 
 
 <!-- ##### USER_FUNCTION GtkDestroyNotify ##### -->
@@ -198,7 +199,7 @@ Defines a function pointer.
 Defines a function pointer.
 </para>
 
-@data: gpointer
+@data: #gpointer
 
 
 <!-- ##### USER_FUNCTION GtkCallbackMarshal ##### -->
@@ -206,10 +207,10 @@ Defines a function pointer.
 Defines a function pointer.
 </para>
 
-@object: GtkObject*
-@data: gpointer
-@n_args: guint
-@args: GtkArg*
+@object: #GtkObject*
+@data: #gpointer
+@n_args: #guint
+@args: #GtkArg*
 
 
 <!-- ##### TYPEDEF GtkSignalMarshaller ##### -->
@@ -504,7 +505,7 @@ function for an instance of the object.  @reserved_1 is used for
 
 <!-- ##### TYPEDEF GtkTypeClass ##### -->
 <para>
-The base structure for a Gtk type. Every type inherits this as a base structure.
+The base structure for a GTK+ type. Every type inherits this as a base structure.
 </para>
 
 
@@ -523,7 +524,7 @@ nickname.
 
 <!-- ##### FUNCTION gtk_type_init ##### -->
 <para>
-Initializes the data structures associated with Gtk types.
+Initializes the data structures associated with GTK+ types.
 </para>
 
 @debug_flags: 
@@ -555,7 +556,7 @@ Returns a pointer to the name of a type, or %NULL if it has none.
 Gets the internal representation of a type, given its name.
 </para>
 
-@name: the name of a Gtk type
+@name: the name of a GTK+ type
 @Returns: a #GtkType.
 
 
index cb107cfd4360d7b352d737d80ab7e441de005afc..5ed764d496422c0de2a18059411710e287389b94 100644 (file)
@@ -88,10 +88,10 @@ Tells about certain properties of the widget.
 
 <!-- ##### MACRO GTK_WIDGET_TYPE ##### -->
 <para>
-
+Gets the type of a widget.
 </para>
 
-@wid: 
+@wid: a #GtkWidget.
 
 
 <!-- ##### MACRO GTK_WIDGET_STATE ##### -->
index 0e9b4866a615598209fab061b6b5df5eb57ffa40..080b3d0ecb5243192c009045ab128e2808b9166a 100644 (file)
@@ -241,6 +241,13 @@ _gtk_accel_group_detach (GtkAccelGroup *accel_group,
   g_object_unref (accel_group);
 }
 
+/**
+ * gtk_accel_groups_from_object:
+ * @object:        a #GObject, usually a #GtkWindow 
+ * @returns: a list of all accel groups which are attached to @object
+ *
+ * Gets a list of all accel groups which are attached to @object.
+ */
 GSList*
 gtk_accel_groups_from_object (GObject *object)
 {
@@ -249,6 +256,18 @@ gtk_accel_groups_from_object (GObject *object)
   return g_object_get_qdata (object, quark_acceleratable_groups);
 }
 
+/**
+ * gtk_accel_group_find:
+ * @accel_group: a #GtkAccelGroup
+ * @find_func: a function to filter the entries of @accel_group with
+ * @data: data to pass to @find_func
+ * @returns: the key of the first entry passing @find_func. The key is 
+ * owned by GTK+ and must not be freed.
+ *
+ * Finds the first entry in an accelerator group for which @find_func
+ * returns %TRUE and returns its #GtkAccelKey.
+ *
+ */
 GtkAccelKey*
 gtk_accel_group_find (GtkAccelGroup  *accel_group,
                      gboolean (*find_func) (GtkAccelKey *key,
@@ -651,6 +670,17 @@ _gtk_accel_group_reconnect (GtkAccelGroup *accel_group,
   g_object_unref (accel_group);
 }
 
+/**
+ * gtk_accel_group_query:
+ * @accel_group:      the accelerator group to query
+ * @accel_key:        key value of the accelerator
+ * @accel_mods:       modifier combination of the accelerator
+ * @n_entries:        location to return the number of entries found, or %NULL
+ * @returns:          an array of @n_entries #GtkAccelGroupEntry elements, or %NULL. The array is owned by GTK+ and must not be freed. 
+ *
+ * Queries an accelerator group for all entries matching @accel_key and 
+ * @accel_mods.
+ */
 GtkAccelGroupEntry*
 gtk_accel_group_query (GtkAccelGroup  *accel_group,
                       guint           accel_key,
@@ -670,6 +700,14 @@ gtk_accel_group_query (GtkAccelGroup  *accel_group,
   return entries;
 }
 
+/**
+ * gtk_accel_group_from_accel_closure:
+ * @closure: a #GClosure
+ * @returns: the #GtkAccelGroup to which @closure is connected, or %NULL.
+ *
+ * Finds the #GtkAccelGroup to which @closure is connected; 
+ * see gtk_accel_group_connect().
+ */
 GtkAccelGroup*
 gtk_accel_group_from_accel_closure (GClosure *closure)
 {
@@ -711,7 +749,7 @@ _gtk_accel_group_activate (GtkAccelGroup  *accel_group,
 
 /**
  * gtk_accel_groups_activate:
- * @object:        the #Gobject, usually a #GtkWindow, on which
+ * @object:        the #GObject, usually a #GtkWindow, on which
  *                 to activate the accelerator.
  * @accel_key:     accelerator keyval from a key event
  * @accel_mods:    keyboard state mask from a key event
index 745ceca639d45c288d9a2b0da7382b06472a4f08..67560b5775424d0bb47b22342c53e54a7e707813 100644 (file)
@@ -428,6 +428,14 @@ check_accel_changed (GtkAccelGroup  *accel_group,
     gtk_accel_label_queue_refetch (accel_label);
 }
 
+/**
+ * gtk_accel_label_set_accel_closure:
+ * @accel_label: a #GtkAccelLabel
+ * @accel_closure: the closure to monitor for accelerator changes.
+ *
+ * Sets the closure to be monitored by this accelerator label. The closure
+ * must be connected to an accelerator group; see gtk_accel_group_connect().
+ **/
 void
 gtk_accel_label_set_accel_closure (GtkAccelLabel *accel_label,
                                   GClosure      *accel_closure)